Class: com.microstrategy.web.app.taglibs.UrlEventTag
Description:
This custom tags enables users to define links related with an event within JSP pages.
Usage examples are described in "MicroStrategy Developer Library > Web SDK > References > MicroStrategy Custom HTML Tags Reference", if you aren't already viewing this there.
Usage:
The following example shows a link defined with this custom tag that will include all the necessary information for it to take the user to the Preferences page and show the Prompt options (as specified by the event and its argument). The text to be shown as part of the link is the string for "Prompts" according to the language selected by the user.
<web:urlEvent eventID="com.microstrategy.web.app.beans.EnumServletEvents.WebEventOpenPreferences">
<web:eventArgument name="com.microstrategy.web.app.beans.EnumServletEvents.WebEventArgumentPreferenceGroup" value="prompts"/>
<web:descriptor key="mstrWeb.326" desc="Prompts" />
</web:urlEvent>
| Name | Required? | Description |
| baseBean | false | To be used together with the eventID attribute, it indicates which bean from the page
shall be used as base for generating the event to be displayed by this tag. |
| cssClass | false | Indicates the name of the css class to be used when rendering the HTML content to be generated
by this tag. Usage: The css style specified here will be used as formatting for the link (if any) to be generated by the event tag. If the information to display is enabled (based on the enableEvent attribute value) then the enabledCssClass value will be used instead if available. |
| enableEvent | false | Indicates which feature condition could also be checked when trying to determine
if the event will be enabled or not. Usage: The string given as attribute value has to belong to the list of possible features to check for, defined
in enumerations like EnumAppWebFeatures. The condition defined here will be combined together with the
boolean value generated by the feature attribute value specified. |
| enabledCssClass | false | Indicates the css style to be used for events whose links will be enabled. Usage: If enableEvent attribute is missing, this value will be used as regular cssClass for the element (since it's always enabled). If the enabledCssClass and the enableEvent are missing but the cssClass attribute is specified, it will then be used for all enabled links. |
| eventID | true | Indicates the ID of the event that will be used for generating this tag (form, link, etc). The event defined here should be a valid one, otherwise it will not have an effect on the resulting HTML to be shown to the user. |
| extraURL | false | Indicates any other extra attributes to be included on the HTML tag to render for this event tag. Usage: It can be used for including JavaScript calls triggered by different events, etc. |
| includeState | false | Indicates if the URL information to generate for this event will include the state of the beans
on the page or not. |
| linkAttributes | false | Sets the value assigned to the linkAttributes attribute of the custom tag instance that uses this helper |
| stateLevel | false | To be used together with the includeState attribute value, it indicates the level of information to
be added from each one of the beans defined on the page, to the resulting URL information to use for this event. Usage: The value to specify here can be any of the values defined on the EnumWebPersistableState enumeration. |
| target | false | Indicates the target to use for the event to handle on this custom tag. Usage: The value assigned to this attribute shall be used as TARGET value on the HTML tag to create with the given information (for example: <FORM TARGET="xxx" ACTION=... > or
<A TARGET="xxx" HREF=... > |
| titleID | false | set the value assigned to titleID to be used in tag's attribute TITLE. Usage: The titleID specified here will be used to set attribute TITLE. |